Loading TOC...

MarkLogic 10 Product Documentation
GET /manage/v2/databases/{id|name}/partition-queries

Summary

Retrieve a list of partition queries in a database.

URL Parameters
format The format of the data in the response body. Can be either html, json, or xml. Use this parameter to override the Accept header.
Request Headers
Accept The expected MIME type of the response. If the format parameter is present, it takes precedence over the Accept header.
Content-type The MIME type of the data in the request body. Depending upon the value of the format parameter or Accept header, one of application/xml, application/json, or text/html.
Response Headers
Content-type The MIME type of the data in the response body. Depending upon the value of the format parameter or Accept header, one of application/xml, application/json, or text/html.

Response

Upon success, MarkLogic server returns status code 200 (OK) and the response body contains the list of partitions, in the requested format. A status code of 401 (Unauthorized) is returned if the user does not have the necessary privileges.

Required Privileges

This operation requires the manage-user role, or the following privilege:

http://marklogic.com/xdmp/privileges/manage

Usage Notes

The structure of the output returned from this REST API is as follows:

meta

Properties of the view rather than the resource.

This is a complex structure with the following children:

uri

The path to the view.

current-time

The timestamp for when the view was generated.

elapsed-time

The time required to construct the view. The elapsed time indicates the relative cost of generating the view. Consider the cost when determining how frequently to request a view.

start-min

The timestamp for filtering out more recent requests or transactions.

view-error

An error limiting the data in the view.

This is a complex structure with the following children:

error-type

The kind of error.

error-name

The name of the error.

error-code

The error identifier.

error-message

The error text.

relations

Relationships to resources.

This is a complex structure with the following children:

relation-group

Related resources with the same type.

This is a complex structure with the following children:

uriref

The path for a resource or list of resources.

typeref

The type of a resource or list of resources.

roleref

A role that distinguishes the resource.

relation-count

The number of related resources.

relation

A specific related resource.

This is a complex structure with the following children:

qualifiers

A list of associated resources that distinguish the resource.

This is a complex structure with the following children:

qualifier

Another resource that qualifies the resource.

This is a complex structure with the following children:

uriref

The path for a resource or list of resources.

typeref

The type of a resource or list of resources.

idref

The numeric identifier for the resource.

nameref

The name of the resource.

uriref

The path for a resource or list of resources.

typeref

The type of a resource or list of resources.

roleref

A role that distinguishes the resource.

idref

The numeric identifier for the resource.

nameref

The name of the resource.

list-items

Items of this resource type.

This is a complex structure with the following children:

list-count

The number of items of this resource type.

list-item

An item of this resource type.

This is a complex structure with the following children:

uriref

The path for a resource or list of resources.

roleref

A role that distinguishes the resource.

idref

The numeric identifier for the resource.

nameref

The name of the resource.

item-summary

A brief summary of the partition.

This is a complex structure with the following children:

partition-number

forest-count

range

Range configuration for the range assignment policy.

This is a complex structure with the following children:

lower-bound

The lower bound of the range on the forest.

upper-bound

The upper bound of the range on the forest.

related-views

A list of broader or narrower views on the resource or resource type.

This is a complex structure with the following children:

related-view

A broader or narrower view on the resource or resource type.

This is a complex structure with the following children:

view-type

The kind of view.

view-name

The name of the view.

view-uri

The path for the view.

Example


  http://localhost:8002/manage/v2/databases/Documents/partition-queries

  ==>  Returns a list of the partition queries in the database Documents.

Stack Overflow iconStack Overflow: Get the most useful answers to questions from the MarkLogic community, or ask your own question.